This repository was archived by the owner on Mar 9, 2026. It is now read-only.
docs: reduce AI-like writing in source JSDoc and library documentation#66
Merged
docs: reduce AI-like writing in source JSDoc and library documentation#66
Conversation
- parse.ts: simplify description; replace vague "boundary enforcement" phrasing with direct "Fails completely if any entry violates the rules below — no partial success:" - ParseResult.ts: remove "discriminated union type" from JSDoc; rewrite issues:[] comment to explain the reason for keeping it - IssueCode.ts: remove intro sentence restating the obvious - forbiddenKeys.ts: remove redundant sentences explaining the array - createIssue.ts: reduce to @internal (one-liner internal helper) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Remove or rewrite AI-generated writing patterns across library docs:
- Filler adjectives: "comprehensive", "robust", "seamless"
- Full-sentence bold used as emphasis (e.g. "**Please read...**")
- Period-terminated list introductions ("for the following." → "for:")
- Vague boundary marketing ("establishes a predictable boundary",
"security-focused boundary") → direct descriptions
- Redundant authoritative-reference sentences
- Weak verb forms ("is designed to", "allows you to")
Files: README.md, AGENTS.md, CONTRIBUTING.md, SECURITY.md,
CLAUDE.md, skills/README.md
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #66 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 3 3
Lines 23 23
Branches 5 5
=========================================
Hits 23 23 🚀 New features to boost your workflow:
|
- README: restore `security-focused` label and move description before badges - SECURITY: restore `**closed without action**` bold (intentional policy signal) - CONTRIBUTING: restore opening welcome sentence Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Rewrites AI-generated writing patterns across source JSDoc comments and library documentation. No functional changes.
Type of Change
Boundary Checklist
Security & API Stability
parse,ParseResult,ParseIssue,IssueCode)Testing
bun run check:type:sourcepassesbun run testpassesbun run buildpassesChanges
Source JSDoc (
src/)parse.ts: replaced vague "establishes a security-focused boundary" with direct description; rewrote@paramlist intro as"Fails completely if any entry violates the rules below — no partial success:"ParseResult.ts: removed "This is a discriminated union type." (redundant with the type definition); rewroteissues: []comment to explain why the field is kept on the success branchIssueCode.ts: removed intro sentence restating what the type already expressesforbiddenKeys.ts: removed redundant sentences describing what the array containscreateIssue.ts: reduced to/** @internal */(one-liner internal helper needs no further documentation)Library Documentation
Patterns removed across
README.md,AGENTS.md,CONTRIBUTING.md,SECURITY.md,CLAUDE.md,skills/README.md:comprehensive,robust,seamless)**Please read these documents carefully.**)"for the following."→"for:")"establishes a predictable boundary","security-focused boundary") replaced with direct descriptions"is designed to","allows you to")🤖 Generated with Claude Code